Get the particular dispatch job data associated with this shipment

SecurityAuthToken
Request
path Parameters
shipmentId
required
string <uuid>

The id of the shipment

dispatchJobId
required
string <uuid>

The id of the dispatch job

Responses
200

Successfully returned Dispatch Job data

Response Schema: application/json
created_at
string <date-time>
error_message
string or null

Error message propagated to the user

id
string <uuid>
status
string

The status of the dispatch job

Enum: "PROCESSING" "SUCCESS" "ERROR" "CANCELED" "CANCEL_ERROR"
default

Default error response

get/shipments/{shipmentId}/dispatch-job/{dispatchJobId}/
Request samples
Response samples
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "error_message": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "status": "PROCESSING"
}
Copyright © Shipwell 2024. All right reserved.